Skip to main content

How-To Guides

See the full documentation for detailed instructions on creating custom plug‑ins and streaming events to the knowledge graph.

Hosted Patra endpoints (Tapis Pods)​

CKN itself is self‑hosted — you run the broker, knowledge graph, and dashboard on your own infrastructure via make up. The Patra Knowledge Base it reports model provenance to is hosted as Tapis Pods in the ICICLE tenant:

ServiceURL
Patra REST API (stable)https://patrabackend.pods.icicleai.tapis.io
Patra REST API (dev)https://patrabackend-dev.pods.icicleai.tapis.io
Patra UIhttps://patra.pods.icicleai.tapis.io
Tapis tenanthttps://icicleai.tapis.io

Point patra_agent and any Patra‑integrated plugin at the stable REST API. Writes require a Tapis token from https://icicleai.tapis.io/v3/oauth2/tokens; the stable and dev backends share one database, so treat writes to either as production writes.

Prerequisites​

  • Docker and Docker Compose installed and running.
  • Open network access to the following ports:
    • 7474 (Neo4j Web UI)
    • 7687 (Neo4j Bolt)
    • 2181 (ZooKeeper)
    • 9092 (Kafka Broker)
    • 8083 (Kafka Connect)
    • 8502 (CKN dashboard)

Quick‑Start​

1. Clone the repository and start services​

git clone https://github.com/Plale-Lab/cyberinfrastructure-knowledge-network.git
make up

After setup completes, verify that all modules are running:

docker compose ps

2. Stream an example camera‑trap event​

docker compose -f examples/docker-compose.yml up -d --build

View the streamed data on the CKN dashboard or open the neo4j browser and log in with the credentials mentioned in the docker-compose file. Run MATCH (n) RETURN n to view the streamed data.

Shut down services using:

make down
docker compose -f examples/docker-compose.yml down